home *** CD-ROM | disk | FTP | other *** search
/ Amiga Tools 5 / Amiga Tools 5.iso / tools / disk-tools / file splitter / splat / splat.doc < prev    next >
Encoding:
Text File  |  1996-02-13  |  5.3 KB  |  162 lines
  1.                               -=-=-=-=-=-
  2.                                SPLAT 1.0
  3.                              documentation
  4.                           -=-=-=-=-=-=-=-=-=-
  5.                       11/4/96 by Stephen Cantini
  6.  
  7. INTRODUCTION
  8. -----------------------------
  9. What is splat? Splat is a file splitter with LOTS of features: it can be used
  10. for an easy task such as dividing a file in 3 parts with
  11.  
  12. 1> splat ram:foo 3 parts
  13.  
  14. as well as for this:
  15.  
  16. 1> splat ram:ZZ to ram:foo 8 k search \tAnY\ntH?nG nocase r nocut dowild quick
  17.  
  18. which means "read 8 kbytes of the file ram:zz, then countinue reading until
  19. you find (using case insensitive search) the string \tAnY\ntH?nG (where \t
  20. means tab, \n means line feed and ? means any char ("jolly" char)), then write
  21. all what you have read to the file ram:foo.0, without truncating the last
  22. line of text. Repeat this recursively until you reach the end of ram:zz, then
  23. output to the shell just the number of files created."
  24.  
  25. Shocking, isn't it? ;-)
  26.  
  27.  
  28. REQUIREMENTS
  29. -----------------------------
  30. Splat requires OS 2.04+ to operate correctly, and at least 7 k of ram..;)
  31.  
  32.  
  33. LICENCE and DISCLAIMER
  34. -----------------------------
  35. Splat is freeware. This means that you can use it without paying anything to
  36. the author, and you are encouraged to spread it all over the world, as long
  37. as you include this doc file in the distribution (source file is optional).
  38. However, I'm NOT responsable for any loss of data or damage to your computer
  39. that splat may cause: use Splat at your OWN risk.
  40. (PS: Do not panic!! Splat has been tested for a long time and it never gave
  41. problems, so there SHOULDN'T be any bug.)
  42.  
  43.  
  44. DISTRIBUTION
  45. -----------------------------
  46. This archive contains:
  47.  
  48. splat     - the executable
  49. splat.doc - this text
  50. splat.e   - splat source, written in E language
  51.  
  52.  
  53. INSTALLATION
  54. -----------------------------
  55. Just copy it to your C: directory. You can keep also this doc if you want, but
  56. once you read it one time, you probably won't need to do it any more, also
  57. because Splat uses the "extended help" dos feature: try to write in a shell
  58. "splat ?" and then answer another time with "?"...nice, isn't it?
  59.  
  60.  
  61. USAGE
  62. -----------------------------
  63. Splat is a shell-only utility. It's template is:
  64.  
  65. splat FILE/A,S=SEARCH/K,SIZE/N,K/S,LINES/S,TO/K,R=RECURSIVE/S,QUIET/S,
  66.       BUF=BUFFER/K/N,PARTS/S,NOCUT/S,QUICK/S,NOCASE/S,DOWILD/S,MAX/K/N
  67.  
  68. Explaination of each argument:
  69.  
  70. o FILE/A
  71.   The file to be splitted. Wildcards ("#", "?") are not allowed yet.
  72.  
  73. o S=SEARCH/K
  74.   The optional string to search for. It can also include this special codes:
  75.  
  76.            "\t" = Tab (ASCII 9)
  77.            "\n" = Line Feed (ASCII 10)
  78.            "\\" = The "\" character itself
  79.            "\?" = The "?" character itself, for using with the DOWILD option.
  80.  
  81.   Splat uses fast assembly search routines.
  82.  
  83. o SIZE/N
  84.   The length of file to split at, in bytes.
  85.  
  86. o K/S
  87.   This means that size is expressed in Kbytes.
  88.  
  89. o LINES/S
  90.   Size is expressed in lines of text.
  91.   Splat uses a fast assembly routine to count lines.
  92.  
  93. o TO/K
  94.   Optional destination directory/files. If it's just a directory name, then
  95.   the input file name will be used. Splat appends a ".n" extension for each
  96.   file it creates, with n going from 0 to 9999.
  97.  
  98. o R=RECURSIVE/S
  99.   By default, splat cuts a file in two parts, at the specified point. By using
  100.   this switch, you tell splat to cut as more times as it can, till the end of
  101.   the input file. Ex:
  102.  
  103.   1> splat ram:foo 8 k
  104.  
  105.   Divide the file in two parts exactly after 8 kbytes.
  106.  
  107.   1> splat ram:foo 8 k recursive
  108.  
  109.   Divide the file in many "slices" of 8 kbytes each. (The last one will
  110.   probably be shorter)
  111.  
  112. o QUIET/S
  113.   Do not output anything.
  114.  
  115. o BUF=BUFFER/K/N
  116.   Splat allocates a speed-up I/O buffer. By default, this buffer is as big as
  117.   the input file for search-split and lines-split (to get the best searching
  118.   speed), and as big as the specified SIZE in the other cases.
  119.   You can override this by setting your preferred buffer size with this
  120.   keyword. Remember that it's expressed in Kbytes.
  121.   PS: If memory allocation fails splat will try to allocate an 8k buffer
  122.   before giving a "Not enough memory" error.
  123.  
  124. o PARTS/S
  125.   This switch is used, together with SIZE, to divide the file in equal parts.
  126.   Ex: 1> splat ram:foo 3 parts
  127.  
  128. o NOCUT/S
  129.   This switch prevents splat from truncating text lines when dividing text
  130.   files.
  131.  
  132. o QUICK/S
  133.   Use this to make splat output ONLY the number of files created (useful for
  134.   redirection into an env variable, for use inside scripts).
  135.  
  136. o NOCASE/S
  137.   This makes splat' search case INsensitive (default: case sensitive)
  138.  
  139. o DOWILD/S
  140.   This allows you to use the "?" character in the search string as a "jolly"
  141.   character, exactly as the amigados char. Pratically it stands for "any
  142.   character".
  143.  
  144. o MAX/K/N
  145.   With this keyword you can specify the maximum number of files that splat
  146.   can create.
  147.  
  148.  
  149. LAST WORDS
  150. -----------------------------
  151. Hope you like my work!!
  152. If you find any bug, or you think that splat doesn't have a particular
  153. feature (such as making coffee ;), please mail me at :
  154.  
  155.                     E-Mail  :nevez@shock.nervous.com
  156.                              nevez@mbox.vol.it
  157.                     FidoNet :2:332/125.6
  158.                     AmigaNet:39:102/205.6
  159.  
  160.                                                           BYE!!
  161.                                                 Stephen Cantini AKA nevez
  162.